home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / demo / wemdemo4.zip / INFO / LEMACS.6 (.txt) < prev    next >
GNU Info File  |  1994-09-21  |  52KB  |  858 lines

  1. This is Info file ../info/lemacs, produced by Makeinfo-1.55 from the
  2. input file lemacs.txi.
  3.    This file documents the GNU Emacs editor.
  4.    Copyright (C) 1985, 1986, 1988 Richard M. Stallman.  Copyright (C)
  5. 1991, 1992 Lucid, Inc.
  6.    Permission is granted to make and distribute verbatim copies of this
  7. manual provided the copyright notice and this permission notice are
  8. preserved on all copies.
  9.    Permission is granted to copy and distribute modified versions of
  10. this manual under the conditions for verbatim copying, provided also
  11. that the sections entitled "The GNU Manifesto", "Distribution" and "GNU
  12. General Public License" are included exactly as in the original, and
  13. provided that the entire resulting derived work is distributed under the
  14. terms of a permission notice identical to this one.
  15.    Permission is granted to copy and distribute translations of this
  16. manual into another language, under the above conditions for modified
  17. versions, except that the sections entitled "The GNU Manifesto",
  18. "Distribution" and "GNU General Public License" may be included in a
  19. translation approved by the author instead of in the original English.
  20. File: lemacs,  Node: Visiting,  Next: Saving,  Prev: File Names,  Up: Files
  21. Visiting Files
  22. ==============
  23. `C-x C-f'
  24.      Visit a file (`find-file').
  25. `C-x C-v'
  26.      Visit a different file instead of the one visited last
  27.      (`find-alternate-file').
  28. `C-x 4 C-f'
  29.      Visit a file, in another window (`find-file-other-window').  Don't
  30.      change this window.
  31.    "Visiting" a file means copying its contents into an Emacs buffer so
  32. you can edit it.  Emacs creates a new buffer for each file you visit.
  33. We say that the buffer is visiting the file that it was created to
  34. hold.  Emacs constructs the buffer name from the file name by throwing
  35. away the directory, keeping just the file name.  For example, a file
  36. named `/usr/rms/emacs.tex' is displayed in a buffer named `emacs.tex'.
  37. If a buffer with that name exists, a unique name is constructed by
  38. appending `<2>', `<3>',and so on, using the lowest number that makes a
  39. name that is not already in use.
  40.    Each window's mode line shows the name of the buffer that is being
  41. displayed in that window, so you can always tell what buffer you are
  42. editing.
  43.    The changes you make with Emacs are made in the Emacs buffer.  They
  44. do not take effect in the file that you visit, or any other permanent
  45. place, until you "save" the buffer.  Saving the buffer means that Emacs
  46. writes the current contents of the buffer into its visited file.  *Note
  47. Saving::.
  48.    If a buffer contains changes that have not been saved, the buffer is
  49. said to be "modified".  This is important because it implies that some
  50. changes will be lost if the buffer is not saved.  The mode line displays
  51. two stars near the left margin if the buffer is modified.
  52.    To visit a file, use the command `C-x C-f' (`find-file').  Follow
  53. the command with the name of the file you wish to visit, terminated by a
  54. RET.  If you are using Lucid GNU Emacs under X, you can also use the
  55. Open File... command from the File menu bar item.
  56.    The file name is read using the minibuffer (*note Minibuffer::.),
  57. with defaulting and completion in the standard manner (*note File
  58. Names::.).  While in the minibuffer, you can abort `C-x C-f' by typing
  59. `C-g'.
  60.    `C-x C-f' has completed successfully when text appears on the screen
  61. and a new buffer name appears in the mode line.  If the specified file
  62. does not exist and could not be created or cannot be read, an error
  63. results.  The error message is printed in the echo area, and includes
  64. the name of the file that Emacs was trying to visit.
  65.    If you visit a file that is already in Emacs, `C-x C-f' does not make
  66. another copy.  It selects the existing buffer containing that file.
  67. However, before doing so, it checks that the file itself has not changed
  68. since you visited or saved it last.  If the file has changed, Emacs
  69. prints a warning message.  *Note Simultaneous Editing: Interlocking.
  70.    You can switch to a specific file called out in the current buffer by
  71. calling the function `find-this-file'. By providing a prefix argument,
  72. this function calls `filename-at-point' and switches to a buffer
  73. visiting the file FILENAME. It creates one if none already exists. You
  74. can use this function to edit the file mentioned in the buffer you are
  75. working in or to test if the file exists. You can do that by using the
  76. minibuffer completion after snatching the all or part of the filename.
  77.    You can display a file in a new screen by using the function
  78. `find-file-new-screen'. This function is similar to `find-file' except
  79. that it creates a new screen in which the file is displayed.
  80.    If the variable `find-file-use-truenames''s value is non-`nil', a
  81. buffer's visited filename will always be traced back to the real file.
  82. The filename will never be a symbolic link, and there will never be a
  83. symbolic link anywhere in its directory path. In other words, the
  84. `buffer-file-name' and `buffer-file-truename' will be equal.
  85.    If the variable `find-file-compare-truenames' value is non-`nil',
  86. the `find-file' command will check the `buffer-file-truename' of all
  87. visited files when deciding whether a given file is already in a
  88. buffer, instead of just `buffer-file-name'.  If you attempt to visit
  89. another file which is a hard-link or symbolic-link to a file that is
  90. already in a buffer, the existing buffer will be found instead of a
  91. newly created one.
  92.    If you want to create a file, just visit it.  Emacs prints `(New
  93. File)' in the echo area, but in other respects behaves as if you had
  94. visited an existing empty file.  If you make any changes and save them,
  95. the file is created.
  96.    If you visit a nonexistent file unintentionally (because you typed
  97. the wrong file name), use the `C-x C-v' (`find-alternate-file') command
  98. to visit the file you wanted.  `C-x C-v' is similar to `C-x C-f', but
  99. it kills the current buffer (after first offering to save it if it is
  100. modified).  `C-x C-v' is allowed even if the current buffer is not
  101. visiting a file.
  102.    If the file you specify is actually a directory, Dired is called on
  103. that directory (*note Dired::.).  To inhibit this, set the variable
  104. `find-file-run-dired' to `nil'; then it is an error to try to visit a
  105. directory.
  106.    `C-x 4 f' (`find-file-other-window') is like `C-x C-f' except that
  107. the buffer containing the specified file is selected in another window.
  108. The window that was selected before `C-x 4 f' continues to show the
  109. same buffer it was already showing.  If you use this command when only
  110. one window is being displayed, that window is split in two, with one
  111. window showing the same buffer as before, and the other one showing the
  112. newly requested file.  *Note Windows::.
  113.    Use the function `find-this-file-other-window' to edit a file
  114. mentioned in the buffer yuou are editing or to test if that file exists.
  115. To do do this, use the minibuffer completion after snatching the part or
  116. all of the filename. By providing a prefix argument, the function calls
  117. `filename-at-point' abd switches you to a buffer visiting the file
  118. FILENAME in another window. The function creates a buffer if none
  119. already exists. This function is similar to `find-file-other-window'.
  120.    There are two hook variables that allow extensions to modify the
  121. operation of visiting files.  Visiting a file that does not exist runs
  122. the functions in the list `find-file-not-found-hooks'; the value of this
  123. variable is expected to be a list of functions which are called one by
  124. one until one of them returns non-`nil'.  Any visiting of a file,
  125. whether extant or not, expects `find-file-hooks' to contain list of
  126. functions and calls them all, one by one.  In both cases the functions
  127. receive no arguments.  Visiting a nonexistent file runs the
  128. `find-file-not-found-hooks' first.
  129. File: lemacs,  Node: Saving,  Next: Reverting,  Prev: Visiting,  Up: Files
  130. Saving Files
  131. ============
  132.    "Saving" a buffer in Emacs means writing its contents back into the
  133. file that was visited in the buffer.
  134. `C-x C-s'
  135.      Save the current buffer in its visited file (`save-buffer').
  136. `C-x s'
  137.      Save any or all buffers in their visited files
  138.      (`save-some-buffers').
  139. `M-~'
  140.      Forget that the current buffer has been changed (`not-modified').
  141. `C-x C-w'
  142.      Save the current buffer in a specified file, and record that file
  143.      as the one visited in the buffer (`write-file').
  144. `M-x set-visited-file-name'
  145.      Change file the name under which the current buffer will be saved.
  146.    To save a file and make your changes permanent, type `C-x C-s'
  147. (`save-buffer').  After saving is finished, `C-x C-s' prints a message
  148.      Wrote /u/rms/gnu/gnu.tasks
  149. If the selected buffer is not modified (no changes have been made in it
  150. since the buffer was created or last saved), Emacs does not save it
  151. because it would have no effect.  Instead, `C-x C-s' prints a message
  152. in the echo area saying
  153.      (No changes need to be written)
  154.    The command `C-x s' (`save-some-buffers') can save any or all
  155. modified buffers.  First it asks, for each modified buffer, whether to
  156. save it.  The questions should be answered with `y' or `n'.  `C-x C-c',
  157. the key that kills Emacs, invokes `save-some-buffers' and therefore
  158. asks the same questions.
  159.    If you have changed a buffer and do not want the changes to be saved,
  160. you should take some action to prevent it.  Otherwise, you are liable to
  161. save it by mistake each time you use `save-some-buffers' or a related
  162. command.  One thing you can do is type `M-~' (`not-modified'), which
  163. removes the indication that the buffer is modified.  If you do this,
  164. none of the save commands will believe that the buffer needs to be
  165. saved.  (`~' is often used as a mathematical symbol for `not'; thus
  166. `Meta-~' is `not', metafied.) You could also use
  167. `set-visited-file-name' (see below) to mark the buffer as visiting a
  168. different file name, not in use for anything important.
  169.    You can also undo all the changes made since the file was visited or
  170. saved, by reading the text from the file again.  This is called
  171. "reverting".  *Note Reverting::.  Alternatively, you can undo all the
  172. changes by repeating the undo command `C-x u'; but this only works if
  173. you have not made more changes than the undo mechanism can remember.
  174.    `M-x set-visited-file-name' alters the name of the file that the
  175. current buffer is visiting.  It prompts you for the new file name in the
  176. minibuffer.  You can also use `set-visited-file-name' on a buffer that
  177. is not visiting a file.  The buffer's name is changed to correspond to
  178. the file it is now visiting unless the new name is already used by a
  179. different buffer; in that case, the buffer name is not changed.
  180. `set-visited-file-name' does not save the buffer in the newly visited
  181. file; it just alters the records inside Emacs so that it will save the
  182. buffer in that file.  It also marks the buffer as "modified" so that
  183. `C-x C-s' will save.
  184.    If you wish to mark a buffer as visiting a different file and save it
  185. right away, use `C-x C-w' (`write-file').  It is precisely equivalent
  186. to `set-visited-file-name' followed by `C-x C-s'.  `C-x C-s' used on a
  187. buffer that is not visiting  a file has the same effect as `C-x C-w';
  188. that is, it reads a file name, marks the buffer as visiting that file,
  189. and saves it there.  The default file name in a buffer that is not
  190. visiting a file is made by combining the buffer name with the buffer's
  191. default directory.
  192.    If Emacs is about to save a file and sees that the date of the latest
  193. version on disk does not match what Emacs last read or wrote, Emacs
  194. notifies you of this fact, because it probably indicates a problem
  195. caused by simultaneous editing and requires your immediate attention.
  196. *Note Simultaneous Editing: Interlocking.
  197.    If the variable `require-final-newline' is non-`nil', Emacs puts a
  198. newline at the end of any file that doesn't already end in one, every
  199. time a file is saved or written.
  200.    Use the hook variable `write-file-hooks' to implement other ways to
  201. write files, and specify things to be done before files are written.
  202. The value of this variable should be a list of Lisp functions.  When a
  203. file is to be written, the functions in the list are called, one by
  204. one, with no arguments.  If one of them returns a non-`nil' value, Emacs
  205. takes this to mean that the file has been written in some suitable
  206. fashion; the rest of the functions are not called, and normal writing is
  207. not done. Use the hook variable `after-write-file-hooks' to list all
  208. the functions to be called after writing out a buffer to a file.
  209. * Menu:
  210. * Backup::       How Emacs saves the old version of your file.
  211. * Interlocking:: How Emacs protects against simultaneous editing
  212.                   of one file by two users.
  213. File: lemacs,  Node: Backup,  Next: Interlocking,  Prev: Saving,  Up: Saving
  214. Backup Files
  215. ------------
  216.    Because Unix does not provide version numbers in file names,
  217. rewriting a file in Unix automatically destroys all record of what the
  218. file used to contain.  Thus, saving a file from Emacs throws away the
  219. old contents of the file--or it would, except that Emacs carefully
  220. copies the old contents to another file, called the "backup" file,
  221. before actually saving.  (Provided the variable `make-backup-files' is
  222. non-`nil'.  Backup files are not written if this variable is `nil').
  223.    At your option, Emacs can keep either a single backup file or a
  224. series of numbered backup files for each file you edit.
  225.    Emacs makes a backup for a file only the first time a file is saved
  226. from one buffer.  No matter how many times you save a file, its backup
  227. file continues to contain the contents from before the file was visited.
  228. Normally this means that the backup file contains the contents from
  229. before the current editing session; however, if you kill the buffer and
  230. then visit the file again, a new backup file is made by the next save.
  231. * Menu:
  232. * Names: Backup Names.        How backup files are named;
  233.                 Choosing single or numbered backup files.
  234. * Deletion: Backup Deletion.    Emacs deletes excess numbered backups.
  235. * Copying: Backup Copying.    Backups can be made by copying or renaming.
  236. File: lemacs,  Node: Backup Names,  Next: Backup Deletion,  Prev: Backup,  Up: Backup
  237. Single or Numbered Backups
  238. ..........................
  239.    If you choose to have a single backup file (the default), the backup
  240. file's name is constructed by appending `~' to the file name being
  241. edited; thus, the backup file for `eval.c' is `eval.c~'.
  242.    If you choose to have a series of numbered backup files, backup file
  243. names are made by appending `.~', the number, and another `~' to the
  244. original file name.  Thus, the backup files of `eval.c' would be called
  245. `eval.c.~1~', `eval.c.~2~', and so on, through names like
  246. `eval.c.~259~' and beyond.
  247.    If protection stops you from writing backup files under the usual
  248. names, the backup file is written as `%backup%~' in your home directory.
  249. Only one such file can exist, so only the most recently made backup is
  250. available.
  251.    The choice of single backup or numbered backups is controlled by the
  252. variable `version-control'.  Its possible values are
  253.      Make numbered backups.
  254. `nil'
  255.      Make numbered backups for files that have numbered backups already.
  256.      Otherwise, make single backups.
  257. `never'
  258.      Never make numbered backups; always make single backups.
  259. `version-control' may be set locally in an individual buffer to control
  260. the making of backups for that buffer's file.  For example, Rmail mode
  261. locally sets `version-control' to `never' to make sure that there is
  262. only one backup for an Rmail file.  *Note Locals::.
  263. File: lemacs,  Node: Backup Deletion,  Next: Backup Copying,  Prev: Backup Names,  Up: Backup
  264. Automatic Deletion of Backups
  265. .............................
  266.    To prevent unlimited consumption of disk space, Emacs can delete
  267. numbered backup versions automatically.  Generally Emacs keeps the
  268. first few backups and the latest few backups, deleting any in between.
  269. This happens every time a new backup is made.  The two variables that
  270. control the deletion are `kept-old-versions' and `kept-new-versions'.
  271. Their values are, respectively the number of oldest (lowest-numbered)
  272. backups to keep and the number of newest (highest-numbered) ones to
  273. keep, each time a new backup is made.  The values are used just after a
  274. new backup version is made; that newly made backup is included in the
  275. count in `kept-new-versions'.  By default, both variables are 2.
  276.    If `trim-versions-without-asking' is non-`nil',  excess middle
  277. versions are deleted without notification.  If it is `nil', the
  278. default, you are asked whether the excess middle versions should really
  279. be deleted.
  280.    You can also use Dired's `.' (Period) command to delete old versions.
  281. *Note Dired::.
  282. File: lemacs,  Node: Backup Copying,  Prev: Backup Deletion,  Up: Backup
  283. Copying vs. Renaming
  284. ....................
  285.    You can make backup files by copying the old file or by renaming it.
  286. This makes a difference when the old file has multiple names.  If you
  287. rename the old file into the backup file, the alternate names become
  288. names for the backup file.  If you copy the old file instead, the
  289. alternate names remain names for the file that you are editing, and the
  290. contents accessed by those names will be the new contents.
  291.    How you make a backup file may also affect the file's owner and
  292. group.  If you use copying, they do not change.  If renaming is used,
  293. you become the file's owner, and the file's group becomes the default
  294. (different operating systems have different defaults for the group).
  295.    Having the owner change is usually a good idea, because then the
  296. owner always shows who last edited the file.  The owners of the backups
  297. show who produced them.  Occasionally there is a file whose owner
  298. should not change.  Since most files` owner should change, it is a good
  299. idea to use local variable lists to set
  300. `backup-by-copying-when-mismatch' for the special cases where the owner
  301. should change.(*note File Variables::.).
  302.    Three variables control the choice of renaming or copying.
  303. Normally, renaming is done.  If the variable `backup-by-copying' is
  304. non-`nil', copying is used.  Otherwise, if the variable
  305. `backup-by-copying-when-linked' is non-`nil', copying is done for files
  306. that have multiple names, but renaming may still be done when the file
  307. being edited has only one name.  If the variable
  308. `backup-by-copying-when-mismatch' is non-`nil', copying is done if
  309. renaming would cause the file's owner or group to change.
  310. File: lemacs,  Node: Interlocking,  Prev: Backup,  Up: Saving
  311. Protection against Simultaneous Editing
  312. ---------------------------------------
  313.    Simultaneous editing occurs when two users visit the same file, both
  314. make changes, and both save their changes.  If no one was informed that
  315. this was happening, and you saved first, you would later find that your
  316. changes were lost.  On some systems, Emacs notices immediately when the
  317. second user starts to change a file already being edited, and issues a
  318. warning.  When this is not possible, or if the second user has started
  319. to change the file despite the warning, Emacs checks when the file is
  320. saved, and issues a second warning when a user is about to overwrite a
  321. file containing another user's changes.  If you are the user editing the
  322. file, you can take corrective action at this point and prevent actual
  323. loss of work.
  324.    When you make the first modification in an Emacs buffer that is
  325. visiting a file, Emacs records that you have locked the file.  (It does
  326. this by writing another file in a directory reserved for this purpose.)
  327. The lock is removed when you save the changes.  The idea is that the
  328. file is locked whenever the buffer is modified.  If you begin to modify
  329. the buffer while the visited file is locked by someone else, this
  330. constitutes a collision, and Emacs asks you what to do.  It does this
  331. by calling the Lisp function `ask-user-about-lock', which you can
  332. redefine to customize what it does.  The standard definition of this
  333. function asks you a question and accepts three possible answers:
  334.      Steal the lock.  Whoever was already changing the file loses the
  335.      lock, and you get the lock.
  336.      Proceed.  Go ahead and edit the file despite its being locked by
  337.      someone else.
  338.      Quit.  This causes an error (`file-locked') and the modification
  339.      you were trying to make in the buffer does not actually take place.
  340.    Note that locking works on the basis of a file name; if a file has
  341. multiple names, Emacs does not realize that the two names are the same
  342. file and cannot prevent two users from editing it simultaneously under
  343. different names.  However, basing locking on names means that Emacs can
  344. interlock the editing of new files that do not really exist until they
  345. are saved.
  346.    Some systems are not configured to allow Emacs to make locks.  On
  347. these systems, Emacs cannot detect trouble in advance, but it can still
  348. detect it in time to prevent you from overwriting someone else's
  349. changes.
  350.    Every time Emacs saves a buffer, it first checks the
  351. last-modification date of the existing file on disk to see that it has
  352. not changed since the file was last visited or saved.  If the date does
  353. not match, it implies that changes were made in the file in some other
  354. way, and these changes are about to be lost if Emacs actually does
  355. save.  To prevent this, Emacs prints a warning message and asks for
  356. confirmation before saving.  Occasionally you will know why the file
  357. was changed and know that it does not matter; then you can answer `yes'
  358. and proceed.  Otherwise, you should cancel the save with `C-g' and
  359. investigate the situation.
  360.    The first thing you should do when notified that simultaneous editing
  361. has already taken place is to list the directory with `C-u C-x C-d'
  362. (*note Directory Listing: ListDir.).  This will show the file's current
  363. author.  You should attempt to contact that person and ask her not to
  364. continue editing.  Often the next step is to save the contents of your
  365. Emacs buffer under a different name, and use `diff' to compare the two
  366. files.
  367.    Simultaneous editing checks are also made when you visit a file that
  368. is already visited with `C-x C-f' and when you start to modify a file.
  369. This is not strictly necessary, but it is useful to find out about such
  370. a problem as early as possible, when corrective action takes less work.
  371.    Another way to protect your file is to set the read, write, and
  372. executable permissions for the file. Use the function
  373. `set-default-file-mode' to set the UNIX `umask' value to the NMASK
  374. argument. The `umask' value is the default protection mode for new
  375. files.
  376. File: lemacs,  Node: Reverting,  Next: Auto Save,  Prev: Saving,  Up: Files
  377. Reverting a Buffer
  378. ==================
  379.    If you have made extensive changes to a file and then change your
  380. mind about them, you can get rid of all changes by reading in the
  381. previous version of the file.  To do this, use `M-x revert-buffer',
  382. which operates on the current buffer.  Since reverting a buffer can
  383. result in very extensive changes, you must confirm it with `yes'.
  384.    If the current buffer has been auto-saved more recently than it has
  385. been saved explicitly, `revert-buffer' offers to read the auto save file
  386. instead of the visited file (*note Auto Save::.).  Emacs asks you about
  387. the auto save file before the request for confirmation of the
  388. `revert-buffer' operation, and demands `y' or `n' as an answer.  If you
  389. have started to type `yes' for confirmation without realizing that the
  390. auto-save question was going to be asked, the `y' will answer that
  391. question, but the `es' will not be valid confirmation.  This gives you
  392. a chance to cancel the operation with `C-g' and try again with the
  393. answers you really intend.
  394.    `revert-buffer' keeps point at the same distance (measured in
  395. characters) from the beginning of the file.  If the file was edited only
  396. slightly, you will be at approximately the same piece of text after
  397. reverting as before.  If you have made more extensive changes, the
  398. value of point in the old file may bring you to a totally different
  399. piece of text than your last editing point.
  400.    A buffer reverted from its visited file is marked "not modified"
  401. until you make a change.
  402.    Some kinds of buffers whose contents reflect data bases other than
  403. files, such as Dired buffers, can also be reverted.  For them,
  404. reverting means recalculating their contents from the appropriate data.
  405. Buffers created randomly with `C-x b' cannot be reverted;
  406. `revert-buffer' reports an error when asked to do so.
  407. File: lemacs,  Node: Auto Save,  Next: ListDir,  Prev: Reverting,  Up: Files
  408. Auto-Saving: Protection Against Disasters
  409. =========================================
  410.    Emacs saves all the visited files from time to time (based on
  411. counting your keystrokes) without being asked.  This is called
  412. "auto-saving".  It prevents you from losing more than a limited amount
  413. of work if the system crashes.
  414.    When Emacs determines it is time for auto-saving, each buffer is
  415. considered, and is auto-saved if auto-saving is turned on for it and it
  416. has changed since the last time it was auto-saved.  If any auto-saving
  417. is done, the message `Auto-saving...' is displayed in the echo area
  418. until auto-saving is finished.  Errors occurring during auto-saving are
  419. caught so that they do not interfere with the execution of commands you
  420. have been typing.
  421. * Menu:
  422. * Files: Auto Save Files.
  423. * Control: Auto Save Control.
  424. * Recover::        Recovering text from auto-save files.
  425. File: lemacs,  Node: Auto Save Files,  Next: Auto Save Control,  Prev: Auto Save,  Up: Auto Save
  426. Auto-Save Files
  427. ---------------
  428.    Auto-saving does not normally write to the files you visited, because
  429. it can be undesirable to save a program that is in an inconsistent
  430. state when you have made only half of a planned change.  Instead,
  431. auto-saving is done in a different file called the "auto-save file",
  432. and the visited file is changed only when you save explicitly, for
  433. example, with `C-x C-s'.
  434.    Normally, the name of the auto-save file is generated by appending
  435. `#' to the front and back of the visited file name.  Thus, a buffer
  436. visiting file `foo.c' would be auto-saved in a file `#foo.c#'.  Most
  437. buffers that are not visiting files are auto-saved only if you request
  438. it explicitly; when they are auto-saved, the auto-save file name is
  439. generated by appending `#%' to the front and `#' to the back of buffer
  440. name.  For example, the `*mail*' buffer in which you compose messages
  441. to be sent is auto-saved in a file named `#%*mail*#'.  Names of
  442. auto-save files are generated this way unless you customize the
  443. functions `make-auto-save-file-name' and `auto-save-file-name-p' to do
  444. something different.  The file name to be used for auto-saving a buffer
  445. is calculated at the time auto-saving is turned on in that buffer.
  446.    If you want auto-saving to be done in the visited file, set the
  447. variable `auto-save-visited-file-name' to be non-`nil'.  In this mode,
  448. there is really no difference between auto-saving and explicit saving.
  449.    Emacs deletes a buffer's auto-save file when you explicitly save the
  450. buffer.  To inhibit the deletion, set the variable
  451. `delete-auto-save-files' to `nil'.  Changing the visited file name with
  452. `C-x C-w' or `set-visited-file-name' renames any auto-save file to
  453. correspond to the new visited name.
  454. File: lemacs,  Node: Auto Save Control,  Next: Recover,  Prev: Auto Save Files,  Up: Auto Save
  455. Controlling Auto-Saving
  456. -----------------------
  457.    Each time you visit a file, auto-saving is turned on for that file's
  458. buffer if the variable `auto-save-default' is non-`nil' (but not in
  459. batch mode; *note Entering Emacs::.).  The default for this variable is
  460. `t', so Emacs auto-saves buffers that visit files by default.  You can
  461. use the command `M-x auto-save-mode' to turn auto-saving for a buffer
  462. on or off.  Like other minor mode commands, `M-x auto-save-mode' turns
  463. auto-saving on with a positive argument, off with a zero or negative
  464. argument; with no argument, it toggles.
  465.    Emacs performs auto-saving periodically based on counting how many
  466. characters you have typed since the last time auto-saving happened.  The
  467. variable `auto-save-interval' specifies the number of characters
  468. between auto-saves.  By default, it is 300.  Emacs also auto-saves
  469. whenever you call the function `do-auto-save'.
  470.    Emacs also does auto-saving whenever it gets a fatal error.  This
  471. includes killing the Emacs job with a shell command such as `kill
  472. -emacs', or disconnecting a phone line or network connection.
  473.    You can set the number of seconds of idle time before an auto-save is
  474. done.  A value of zero or `nil' means disable auto-saving due to
  475. idleness.
  476.    The actual amount of idle time between auto-saves is logarithmically
  477. related to the size of the current buffer.  This variable is the number
  478. of seconds after which an auto-save will happen when the current buffer
  479. is 50k or less; the timeout will be 2 1/4 times this in a 200k buffer, 3
  480. 3/4 times this in a 1000k buffer, and 4 1/2 times this in a 2000k
  481. buffer.
  482.    For this variable to have any effect, you must do `(require 'timer)'.
  483. File: lemacs,  Node: Recover,  Prev: Auto Save Control,  Up: Auto Save
  484. Recovering Data from Auto-Saves
  485. -------------------------------
  486.    If you want to use the contents of an auto-save file to recover from
  487. a loss of data, use the command `M-x recover-file RET FILE RET'.  Emacs
  488. visits FILE and then (after your confirmation) restores the contents
  489. from the auto-save file `#FILE#'.  You can then save the file with `C-x
  490. C-s' to put the recovered text into FILE itself.  For example, to
  491. recover file `foo.c' from its auto-save file `#foo.c#', do:
  492.      M-x recover-file RET foo.c RET
  493.      C-x C-s
  494.    Before asking for confirmation, `M-x recover-file' displays a
  495. directory listing describing the specified file and the auto-save file,
  496. so you can compare their sizes and dates.  If the auto-save file is
  497. older, `M-x recover-file' does not offer to read it.
  498.    Auto-saving is disabled by `M-x recover-file' because using this
  499. command implies that the auto-save file contains valuable data from a
  500. past session.  If you save the data in the visited file and then go on
  501. to make new changes, turn auto-saving back on with `M-x auto-save-mode'.
  502. File: lemacs,  Node: ListDir,  Next: Dired,  Prev: Auto Save,  Up: Files
  503. Listing a File Directory
  504. ========================
  505.    Files are classified by Unix into "directories".  A "directory
  506. listing" is a list of all the files in a directory.  Emacs provides
  507. directory listings in brief format (file names only) and verbose format
  508. (sizes, dates, and authors included).
  509. `C-x C-d DIR-OR-PATTERN'
  510.      Print a brief directory listing (`list-directory').
  511. `C-u C-x C-d DIR-OR-PATTERN'
  512.      Print a verbose directory listing.
  513.    To print a directory listing, use `C-x C-d' (`list-directory').
  514. This command prompts in the minibuffer for a file name which is either
  515. a  directory to be listed or pattern containing wildcards for the files
  516. to be listed.  For example,
  517.      C-x C-d /u2/emacs/etc RET
  518. lists all the files in directory `/u2/emacs/etc'.  An example of
  519. specifying a file name pattern is
  520.      C-x C-d /u2/emacs/src/*.c RET
  521.    Normally, `C-x C-d' prints a brief directory listing containing just
  522. file names.  A numeric argument (regardless of value) tells it to print
  523. a verbose listing (like `ls -l').
  524.    Emacs obtains the text of a directory listing by running `ls' in an
  525. inferior process.  Two Emacs variables control the switches passed to
  526. `ls': `list-directory-brief-switches' is a string giving the switches
  527. to use in brief listings (`"-CF"' by default).
  528. `list-directory-verbose-switches' is a string giving the switches to
  529. use in a verbose listing (`"-l"' by default).
  530.    The variable `diretory-abbrev-alist' is an alist of abbreviations
  531. for file directories.  The list consists of elements of the form `(FROM
  532. .  TO)', each meaning to replace `FROM' with `TO' when it appears in a
  533. directory name.  This replacement is done when setting up the default
  534. directory of a newly visited file.  Every `FROM' string should start
  535. with ``^''.
  536.    Use this feature when you have directories which you normally refer
  537. to via absolute symbolic links.  Make `TO' the name of the link, and
  538. `FROM' the name it is linked to.
  539. File: lemacs,  Node: Dired,  Next: Misc File Ops,  Prev: ListDir,  Up: Files
  540. Dired, the Directory Editor
  541. ===========================
  542.    Dired makes it easy to delete or visit many of the files in a single
  543. directory at once.  It makes an Emacs buffer containing a listing of the
  544. directory.  You can use the normal Emacs commands to move around in this
  545. buffer, and special Dired commands to operate on the files.
  546. * Menu:
  547. * Enter: Dired Enter.         How to invoke Dired.
  548. * Edit: Dired Edit.           Editing the Dired buffer.
  549. * Deletion: Dired Deletion.   Deleting files with Dired.
  550. * Immed: Dired Immed.         Other file operations through Dired.
  551. File: lemacs,  Node: Dired Enter,  Next: Dired Edit,  Prev: Dired,  Up: Dired
  552. Entering Dired
  553. --------------
  554.    To invoke dired, type `C-x d' or `M-x dired'.  The command reads a
  555. directory name or wildcard file name pattern as a minibuffer argument
  556. just like the `list-directory' command, `C-x C-d'.  Where `dired'
  557. differs from `list-directory' is in naming the buffer after the
  558. directory name or the wildcard pattern used for the listing, and putting
  559. the buffer into Dired mode so that the special commands of Dired are
  560. available in it.  The variable `dired-listing-switches' is a string
  561. used as an argument to `ls' in making the directory; this string must
  562. contain `-l'.
  563.    To display the Dired buffer in another window rather than in the
  564. selected window, use `C-x 4 d' (`dired-other-window)' instead of `C-x
  565. File: lemacs,  Node: Dired Edit,  Next: Dired Deletion,  Prev: Dired Enter,  Up: Dired
  566. Editing in Dired
  567. ----------------
  568.    Once the Dired buffer exists, you can switch freely between it and
  569. other Emacs buffers.  Whenever the Dired buffer is selected, certain
  570. special commands are provided that operate on files that are listed.
  571. The Dired buffer is "read-only", and inserting text in it is not
  572. useful, so ordinary printing characters such as `d' and `x' are used
  573. for Dired commands.  Most Dired commands operate on the file described
  574. by the line that point is on.  Some commands perform operations
  575. immediately; others "flag" the file to be operated on later.
  576.    Most Dired commands that operate on the current line's file also
  577. treat a numeric argument as a repeat count, meaning to act on the files
  578. of the next few lines.  A negative argument means to operate on the
  579. files of the preceding lines, and leave point on the first of those
  580. lines.
  581.    All the usual Emacs cursor motion commands are available in Dired
  582. buffers.  Some special purpose commands are also provided.  The keys
  583. `C-n' and `C-p' are redefined so that they try to position the cursor
  584. at the beginning of the filename on the line, rather than at the
  585. beginning of the line.
  586.    For extra convenience, SPC and `n' in Dired are equivalent to `C-n'.
  587. `p' is equivalent to `C-p'.  Moving by lines is done so often in Dired
  588. that it deserves to be easy to type.  DEL (move up and unflag) is often
  589. useful simply for moving up.
  590.    The `g' command in Dired runs `revert-buffer' to reinitialize the
  591. buffer from the actual disk directory and show any changes made in the
  592. directory by programs other than Dired.  All deletion flags in the Dired
  593. buffer are lost when this is done.
  594. File: lemacs,  Node: Dired Deletion,  Next: Dired Immed,  Prev: Dired Edit,  Up: Dired
  595. Deleting Files with Dired
  596. -------------------------
  597.    The primary use of Dired is to flag files for deletion and then
  598. delete them.
  599.      Flag this file for deletion.
  600.      Remove deletion-flag on this line.
  601. `DEL'
  602.      Remove deletion-flag on previous line, moving point to that line.
  603.      Delete the files that are flagged for deletion.
  604.      Flag all auto-save files (files whose names start and end with `#')
  605.      for deletion (*note Auto Save::.).
  606.      Flag all backup files (files whose names end with `~') for deletion
  607.      (*note Backup::.).
  608. `. (Period)'
  609.      Flag excess numeric backup files for deletion.  The oldest and
  610.      newest few backup files of any one file are exempt; the middle
  611.      ones are flagged.
  612.    You can flag a file for deletion by moving to the line describing the
  613. file and typing `d' or `C-d'.  The deletion flag is visible as a `D' at
  614. the beginning of the line.  Point is moved to the beginning of the next
  615. line, so that repeated `d' commands flag successive files.
  616.    The files are flagged for deletion rather than deleted immediately to
  617. avoid the danger of deleting a file accidentally.  Until you direct
  618. Dired to delete the flagged files, you can remove deletion flags using
  619. the commands `u' and DEL.  `u' works just like `d', but removes flags
  620. rather than making flags.  DEL moves upward, removing flags; it is like
  621. `u' with numeric argument automatically negated.
  622.    To delete the flagged files, type `x'.  This command first displays a
  623. list of all the file names flagged for deletion, and requests
  624. confirmation with `yes'.  Once you confirm, all the flagged files are
  625. deleted, and their lines are deleted from the text of the Dired buffer.
  626. The shortened Dired buffer remains selected.  If you answer `no' or
  627. quit with `C-g', you return immediately to Dired, with the deletion
  628. flags still present and no files actually deleted.
  629.    The `#', `~' and `.' commands flag many files for deletion, based on
  630. their names.  These commands are useful precisely because they do not
  631. actually delete any files; you can remove the deletion flags from any
  632. flagged files that you really wish to keep.
  633.    `#' flags for deletion all files that appear to have been made by
  634. auto-saving (that is, files whose names begin and end with `#').  `~'
  635. flags for deletion all files that appear to have been made as backups
  636. for files that were edited (that is, files whose names end with `~').
  637.    `.' (Period) flags just some of the backup files for deletion: only
  638. numeric backups that are not among the oldest few nor the newest few
  639. backups of any one file.  Normally `dired-kept-versions' (not
  640. `kept-new-versions'; that applies only when saving) specifies the
  641. number of newest versions of each file to keep, and `kept-old-versions'
  642. specifies the number of oldest versions to keep.  Period with a
  643. positive numeric argument, as in `C-u 3 .', specifies the number of
  644. newest versions to keep, overriding `dired-kept-versions'.  A negative
  645. numeric argument overrides `kept-old-versions', using minus the value
  646. of the argument to specify the number of oldest versions of each file
  647. to keep.
  648. File: lemacs,  Node: Dired Immed,  Prev: Dired Deletion,  Up: Dired
  649. Immediate File Operations in Dired
  650. ----------------------------------
  651.    Some file operations in Dired take place immediately when they are
  652. requested.
  653.      Copies the file described on the current line.  You must supply a
  654.      file name to copy to, using the minibuffer.
  655.      Visits the file described on the current line.  It is just like
  656.      typing `C-x C-f' and supplying that file name.  If the file on
  657.      this line is a subdirectory, `f' actually causes Dired to be
  658.      invoked on that subdirectory.  *Note Visiting::.
  659.      Like `f', but uses another window to display the file's buffer.
  660.      The Dired buffer remains visible in the first window.  This is
  661.      like using `C-x 4 C-f' to visit the file.  *Note Windows::.
  662.      Renames the file described on the current line.  You must supply a
  663.      file name to rename to, using the minibuffer.
  664.      Views the file described on this line using `M-x view-file'.
  665.      Viewing a file is like visiting it, but is slanted toward moving
  666.      around in the file conveniently and does not allow changing the
  667.      file.  *Note View File: Misc File Ops.  Viewing a file that is a
  668.      directory runs Dired on that directory.
  669. File: lemacs,  Node: Misc File Ops,  Prev: Dired,  Up: Files
  670. Miscellaneous File Operations
  671. =============================
  672.    Emacs has commands for performing many other operations on files.
  673. All operate on one file; they do not accept wildcard file names.
  674.    You can use the command `M-x add-name-to-file' to add a name to an
  675. existing file without removing the old name.  The new name must belong
  676. on the file system that the file is on.
  677.    `M-x append-to-file' adds the text of the region to the end of the
  678. specified file.
  679.    `M-x copy-file' reads the file OLD and writes a new file named NEW
  680. with the same contents.  Confirmation is required if a file named NEW
  681. already exists, because copying overwrites the old contents of the file
  682.    `M-x delete-file' deletes a specified file, like the `rm' command in
  683. the shell.  If you are deleting many files in one directory, it may be
  684. more convenient to use Dired (*note Dired::.).
  685.    `M-x insert-file' inserts a copy of the contents of a specified file
  686. into the current buffer at point, leaving point unchanged before the
  687. contents and the mark after them.  *Note Mark::.
  688.    `M-x make-symbolic-link' reads two file names OLD and LINKNAME, and
  689. then creates a symbolic link named LINKNAME and pointing at OLD.  The
  690. future attempts to open file LINKNAME will then refer to the file named
  691. OLD at the time the opening is done, or will result in an error if the
  692. name OLD is not in use at that time.  Confirmation is required if you
  693. create the link while LINKNAME is in use.  Note that not all systems
  694. support symbolic links.
  695.    `M-x rename-file' reads two file names OLD and NEW using the
  696. minibuffer, then renames file OLD as NEW.  If a file named NEW already
  697. exists, you must confirm with `yes' or renaming is not done; this is
  698. because renaming causes the old meaning of the name NEW to be lost.  If
  699. OLD and NEW are on different file systems, the file OLD is copied and
  700. deleted.
  701.    `M-x view-file' allows you to scan or read a file by sequential
  702. screenfuls.  It reads a file name argument using the minibuffer.  After
  703. reading the file into an Emacs buffer, `view-file' reads and displays
  704. one windowful.  You can then type SPC to scroll forward one window, or
  705. DEL to scroll backward.  Various other commands are provided for moving
  706. around in the file, but none for changing it; type `C-h' while viewing
  707. a file for a list of them.  Most commands are the default Emacs cursor
  708. motion commands.  To exit from viewing, type `C-c'.
  709. File: lemacs,  Node: Buffers,  Next: Windows,  Prev: Files,  Up: Top
  710. Using Multiple Buffers
  711. **********************
  712.    Text you are editing in Emacs resides in an object called a
  713. "buffer".  Each time you visit a file, Emacs creates a buffer to hold
  714. the file's text.  Each time you invoke Dired, Emacs creates a buffer to
  715. hold the directory listing.  If you send a message with `C-x m', a
  716. buffer named `*mail*' is used to hold the text of the message.  When
  717. you ask for a command's documentation, it appears in a buffer called
  718. `*Help*'.
  719.    At any time, one and only one buffer is "selected".  It is also
  720. called the "current buffer".  Saying a command operates on "the buffer"
  721. really means that the command operates on the selected buffer, as most
  722. commands do.
  723.    When Emacs creates multiple windows, each window has a chosen buffer
  724. which is displayed there, but at any time only one of the windows is
  725. selected and its chosen buffer is the selected buffer.  Each window's
  726. mode line displays the name of the buffer the window is displaying
  727. (*note Windows::.).
  728.    Each buffer has a name which can be of any length but is
  729. case-sensitive.  You can select a buffer using its name.  Most buffers
  730. are created when you visit files; their names are derived from the
  731. files' names.  You can also create an empty buffer with any name you
  732. want.  A newly started Emacs has a buffer named `*scratch*' which you
  733. can use for evaluating Lisp expressions in Emacs.
  734.    Each buffer records what file it is visiting, whether it is
  735. modified, and what major mode and minor modes are in effect in it
  736. (*note Major Modes::.).  Any Emacs variable can be made "local to" a
  737. particular buffer, meaning its value in that buffer can be different
  738. from the value in other buffers.  *Note Locals::.
  739. * Menu:
  740. * Select Buffer::   Creating a new buffer or reselecting an old one.
  741. * List Buffers::    Getting a list of buffers that exist.
  742. * Misc Buffer::     Renaming; changing read-onliness; copying text.
  743. * Kill Buffer::     Killing buffers you no longer need.
  744. * Several Buffers:: How to go through the list of all buffers
  745.                      and operate variously on several of them.
  746. File: lemacs,  Node: Select Buffer,  Next: List Buffers,  Prev: Buffers,  Up: Buffers
  747. Creating and Selecting Buffers
  748. ==============================
  749. `C-x b BUFFER RET'
  750.      Select or create a buffer named BUFFER (`switch-to-buffer').
  751. `C-x 4 b BUFFER RET'
  752.      Similar but select a buffer named BUFFER in another window
  753.      (`switch-to-buffer-other-window').
  754. `M-x switch-to-other-buffer N'
  755.      Switch to the previous buffer.
  756.    To select a buffer named BUFNAME, type `C-x b BUFNAME RET'.  This is
  757. the command `switch-to-buffer' with argument BUFNAME.  You can use
  758. completion on an abbreviation for the buffer name you want (*note
  759. Completion::.).  An empty argument to `C-x b' specifies the most
  760. recently selected buffer that is not displayed in any window.
  761.    Most buffers are created when you visit files, or use Emacs commands
  762. that display text.  You can also create a buffer explicitly by typing
  763. `C-x b BUFNAME RET', which creates a new, empty buffer that is not
  764. visiting any file, and selects it for editing.  The new buffer's major
  765. mode is determined by the value of `default-major-mode' (*note Major
  766. Modes::.).  Buffers not visiting files are usually used for making
  767. notes to yourself.  If you try to save one, you are asked for the file
  768. name to use.
  769.    The function `switch-to-bufer-new-screen' is similar to
  770. `switch-to-buffer' except that it creates a new screen in which to
  771. display the selected buffer.
  772.    Use `M-x switch-to-other-buffer' to visit the previous buffer. If
  773. you supply a positive integer N, the Nth most recent buffer is
  774. displayed. If you supply an argument of 0, the current buffer is moved
  775. to the bottom of the buffer stack.
  776.    Note that you can also use `C-x C-f' and any other command for
  777. visiting a file to switch buffers.  *Note Visiting::.
  778. File: lemacs,  Node: List Buffers,  Next: Misc Buffer,  Prev: Select Buffer,  Up: Buffers
  779. Listing Existing Buffers
  780. ========================
  781. `C-x C-b'
  782.      List the existing buffers (`list-buffers').
  783.    To print a list of all existing buffers, type `C-x C-b'.  Each line
  784. in the list shows one buffer's name, major mode and visited file.  `*'
  785. at the beginning of a line indicates the buffer has been "modified".
  786. If several buffers are modified, it may be time to save some with `C-x
  787. s' (*note Saving::.).  `%' indicates a read-only buffer.  `.' marks the
  788. selected buffer.  Here is an example of a buffer list:
  789.       MR Buffer         Size  Mode           File
  790.       -- ------         ----  ----           ----
  791.      .*  emacs.tex      383402 Texinfo       /u2/emacs/man/emacs.tex
  792.          *Help*         1287  Fundamental
  793.          files.el       23076 Emacs-Lisp     /u2/emacs/lisp/files.el
  794.        % RMAIL          64042 RMAIL          /u/rms/RMAIL
  795.       *% man            747   Dired        /u2/emacs/man/
  796.          net.emacs      343885 Fundamental   /u/rms/net.emacs
  797.          fileio.c       27691 C              /u2/emacs/src/fileio.c
  798.          NEWS           67340 Text           /u2/emacs/etc/NEWS
  799.          *scratch*       0     Lisp Interaction
  800. Note that the buffer `*Help*' was made by a help request; it is not
  801. visiting any file.  The buffer `man' was made by Dired on the directory
  802. `/u2/emacs/man/'.
  803.    As you move the mouse over the `*Buffer List*' buffer, the lines are
  804. highlighted.  This visual cue indicates that clicking the right mouse
  805. button (`button3') will pop up a menu of commands on the buffer
  806. represented by this line.  This menu duplicates most of those commands
  807. which are bound to keys in the `*Buffer List*' buffer.
  808. File: lemacs,  Node: Misc Buffer,  Next: Kill Buffer,  Prev: List Buffers,  Up: Buffers
  809. Miscellaneous Buffer Operations
  810. ===============================
  811. `C-x C-q'
  812.      Toggle read-only status of buffer (`toggle-read-only').
  813. `M-x rename-buffer'
  814.      Change the name of the current buffer.
  815. `M-x view-buffer'
  816.      Scroll through a buffer.
  817.    A buffer can be "read-only", which means that commands to change its
  818. text are not allowed.  Normally, read-only buffers are created by
  819. subsystems such as Dired and Rmail that have special commands to operate
  820. on the text.  Emacs also creates a read-only buffer if you visit a file
  821. that is protected.  To make changes in a read-only buffer, use the
  822. command `C-x C-q' (`toggle-read-only').  It makes a read-only buffer
  823. writable, and makes a writable buffer read-only.  This works by setting
  824. the variable `buffer-read-only', which has a local value in each buffer
  825. and makes a buffer read-only if its value is non-`nil'.
  826.    `M-x rename-buffer' changes the name of the current buffer,
  827. prompting for the new name in the minibuffer.  There is no default.  If
  828. you specify a name that is used by a different buffer, an error is
  829. signalled and renaming is not done.
  830.    `M-x view-buffer' is similar to `M-x view-file' (*note Misc File
  831. Ops::.) but examines an already existing Emacs buffer.  View mode
  832. provides commands for scrolling through the buffer conveniently but not
  833. for changing it.  When you exit View mode, the resulting value of point
  834. remains in effect.
  835.    To copy text from one buffer to another, use the commands `C-x a'
  836. (`append-to-buffer') and `M-x insert-buffer'.  *Note Accumulating
  837. Text::.
  838. File: lemacs,  Node: Kill Buffer,  Next: Several Buffers,  Prev: Misc Buffer,  Up: Buffers
  839. Killing Buffers
  840. ===============
  841.    After using Emacs for a while, you may accumulate a large number of
  842. buffers, and may want to eliminate the ones you no longer need.  There
  843. are several commands for doing this.
  844. `C-x k'
  845.      Kill a buffer, specified by name (`kill-buffer').
  846. `M-x kill-some-buffers'
  847.      Offer to kill each buffer, one by one.
  848.    `C-x k' (`kill-buffer') kills one buffer, whose name you specify in
  849. the minibuffer.  If you type just RET in the minibuffer, the default,
  850. killing the current buffer, is used.  If the current buffer is killed,
  851. the buffer that has been selected recently but does not appear in any
  852. window now is selected.  If the buffer being killed contains unsaved
  853. changes you are asked to confirm with `yes' before the buffer is killed.
  854.    The command `M-x kill-some-buffers' asks about each buffer, one by
  855. one.  An answer of `y' means to kill the buffer.  Killing the current
  856. buffer or a buffer containing unsaved changes selects a new buffer or
  857. asks for confirmation just like `kill-buffer'.
  858.